<html>
<head><meta charset="utf-8"><title>Merging &quot;suggested workflows&quot; into `CONTRIBUTING.md` · t-compiler/wg-rustc-dev-guide · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/index.html">t-compiler/wg-rustc-dev-guide</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html">Merging &quot;suggested workflows&quot; into `CONTRIBUTING.md`</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="198604227"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198604227" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Dylan MacKenzie (ecstatic-morse) <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198604227">(May 24 2020 at 23:01)</a>:</h4>
<p>Hi all. Recently, I've had the urge to expand the "suggested workflows" of the dev-guide and merge it into a cleaned-up <code>CONTRIBUTING.md</code>. I laid out these goals in the docs stream on discord</p>
<blockquote>
<p>I've long wanted to make onboarding easier by giving a very detailed "walkthrough" for each of the ways of contributing in-tree that are <a href="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md">listed in CONTRIBUTING.md</a>. Specifically, I want to provide an exact series of ./x.py and git commands that will are needed to, for example, check out, modify and build the standard library documentation.<br>
Do others think this would be desirable and (more importantly) worth the maintenance burden?<br>
Specifically, there's some ./x.py workflows that AFAICT are not widely known and might alleviate common problems for newcomers (see <a href="https://github.com/rust-lang/rust/pull/71458">https://github.com/rust-lang/rust/pull/71458</a>). Even just telling people what parts what things are going to be slow ahead of time (initial checkout, first build of LLVM if not using the system one) would make things less daunting for first-time contributors.</p>
</blockquote>



<a name="198604277"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198604277" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Dylan MacKenzie (ecstatic-morse) <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198604277">(May 24 2020 at 23:02)</a>:</h4>
<p>This also includes the "How to build and run the compiler" section I suppose.</p>



<a name="198604722"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198604722" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Dylan MacKenzie (ecstatic-morse) <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198604722">(May 24 2020 at 23:16)</a>:</h4>
<p>I'm happy to do the legwork myself with feedback from both y'all and the docs team. cc <span class="user-mention" data-user-id="198054">@mark-i-m</span>  since this is somewhat related to a conversation we had about the first-time contributor survey</p>



<a name="198627144"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198627144" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Chris Simpkins <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198627144">(May 25 2020 at 01:26)</a>:</h4>
<p>+1</p>



<a name="198698680"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198698680" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Santiago Pastorino <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198698680">(May 25 2020 at 20:03)</a>:</h4>
<p><span class="user-mention" data-user-id="118594">@ecstatic-morse</span> this is great <span aria-label="heart" class="emoji emoji-2764" role="img" title="heart">:heart:</span></p>



<a name="198698730"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/198698730" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Santiago Pastorino <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#198698730">(May 25 2020 at 20:04)</a>:</h4>
<p>I've seen this is from yesterday and I was just able to read it, also saw some comments on github and replied</p>



<a name="201191744"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191744" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191744">(Jun 17 2020 at 19:52)</a>:</h4>
<p>Hey <span class="user-mention" data-user-id="116266">@Santiago Pastorino</span> <span class="user-mention" data-user-id="118594">@ecstatic-morse</span> , I just wanted to followup here: I opened <a href="https://github.com/rust-lang/rustc-dev-guide/pull/753">https://github.com/rust-lang/rustc-dev-guide/pull/753</a></p>



<a name="201191816"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191816" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191816">(Jun 17 2020 at 19:53)</a>:</h4>
<p>I think this is largely orthogonal to the ideas you mentioned above. Basically, now that the Getting Started guide is almost ready, I wanted to change the rust-lang/rust README and CONTRIBUTING.md to point to it primarily</p>



<a name="201191857"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191857" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191857">(Jun 17 2020 at 19:53)</a>:</h4>
<p>But then I didn't want to get rid of the content, because I like <span class="user-mention" data-user-id="118594">@ecstatic-morse</span> 's idea</p>



<a name="201191927"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191927" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191927">(Jun 17 2020 at 19:54)</a>:</h4>
<p>So I opened that PR to move it as-is to the rustc-dev-guide until we can clean things up</p>



<a name="201191942"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191942" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191942">(Jun 17 2020 at 19:54)</a>:</h4>
<p>And I took the opportunity to do a bit of reorganizing</p>



<a name="201191951"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201191951" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201191951">(Jun 17 2020 at 19:54)</a>:</h4>
<p>Does this seem like a reasonable approach?</p>



<a name="201192900"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging%20%22suggested%20workflows%22%20into%20%60CONTRIBUTING.md%60/near/201192900" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Santiago Pastorino <a href="https://rust-lang.github.io/zulip_archive/stream/196385-t-compiler/wg-rustc-dev-guide/topic/Merging.20.22suggested.20workflows.22.20into.20.60CONTRIBUTING.2Emd.60.html#201192900">(Jun 17 2020 at 20:02)</a>:</h4>
<p><span aria-label="+1" class="emoji emoji-1f44d" role="img" title="+1">:+1:</span> from me</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>